// --------------------------------------------------------------------------------------------------------------------
// <copyright file="ILiveObjectDescriptor.cs" company="Open Trader">
//   Copyright (c) David Denis (david.denis@systemathics.com)
// </copyright>
// <summary>
//   |  Open Trader - The Open Source Systematic Trading Platform
//   |
//   |  This program is free software: you can redistribute it and/or modify
//   |  it under the terms of the GNU General Public License as published by
//   |  the Free Software Foundation, either version 2 of the License, or
//   |  (at your option) any later version.
//   |
//   |  This program is distributed in the hope that it will be useful,
//   |  but WITHOUT ANY WARRANTY; without even the implied warranty of
//   |  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//   |  GNU General Public License for more details.
//   |
//   |  You should have received a copy of the GNU General Public License
//   |  along with this program.  If not, see http://www.gnu.org/licenses
//   |
//   |  Up to date informations about Open Trader can be found at :
//   |    http://opentrader.org
//   |    http://opentrader.codeplex.com
//   |
//   |  For professional services, please visit us at :
//   |    http://www.systemathics.com
// </summary>
// --------------------------------------------------------------------------------------------------------------------

namespace Org.OpenTrader.Framework.LiveObjects.Interfaces
{
    #region Using Directives

    using System;

    #endregion

    /// <summary>
    /// The interface live object descriptor.
    /// </summary>
    public interface ILiveObjectDescriptor
    {
        // Universal ID

        // Universal ID of the configuration
        #region Properties

        /// <summary>
        /// Gets ConfigurationID.
        /// </summary>
        Guid ConfigurationID { get; }

        /// <summary>
        /// Gets ID.
        /// </summary>
        Guid ID { get; }

        /// <summary>
        /// Gets the interface type.
        /// </summary>
        string InterfaceType { get; }

        /// <summary>
        /// Gets memo of the intance (may be null).
        /// </summary>
        string Label { get; }

        /// <summary>
        /// Gets Name.
        /// </summary>
        string Name { get; }

        /// <summary>
        /// Gets ParentID.
        /// </summary>
        Guid ParentID { get; }

        #endregion
    }

    /// <summary>
    /// The interface local live object descriptor.
    /// </summary>
    public interface ILocalLiveObjectDescriptor : ILiveObjectDescriptor
    {
        #region Properties

        /// <summary>
        /// Gets ClassType.
        /// </summary>
        string ClassType { get; }

        /// <summary>
        /// Gets ContainerID.
        /// </summary>
        Guid ContainerID { get; }

        /// <summary>
        /// Gets The interface to listen to with a .NET server (it will listen and serve a InterfaceType interface).
        /// </summary>
        string ListenURL { get; }

        #endregion
    }

    /// <summary>
    /// The interface remote live object descriptor.
    /// </summary>
    public interface IRemoteLiveObjectDescriptor : ILiveObjectDescriptor
    {
        // URL to obtain a stub from
        #region Properties

        /// <summary>
        /// Gets URL.
        /// </summary>
        string URL { get; }

        #endregion
    }
}